/*
 * Copyright 2008 Max Kugland
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.splink.library.reflection {

	/**
	 * <code>Parameter</code> represents a parameter of a method. 
	 * 
	 * @author Max Kugland
	 */
	public class Parameter {
		private var _index : int;
		private var _type : String;
		private var _isOptional : Boolean;

		/**
		 * @param index the position at which the <code>Parameter</code> occurs
		 * @param type the type of the <code>Parameter</code>
		 * @param optional whether the parameter is mandatory (false) or optional (true)
		 */
		public function Parameter(index : int, type : String, isOptional : Boolean) {
			_index = index;
			_type = type;
			_isOptional = isOptional;
		}

		/**
		 * @return the position at which the <code>Parameter</code> occurs
		 */
		public function get index() : int {
			return _index;
		}

		/**
		 * @return the type of the <code>Parameter</code>
		 */
		public function get type() : String {
			return _type;
		}

		/**
		 * @return whether the parameter is mandatory (false) or optional (true)
		 */
		public function get isOptional() : Boolean {
			return _isOptional;
		}
	}
}
